Migrate documentation from VitePress to Fumadocs#138
Merged
huangyiirene merged 6 commits intomainfrom Jan 19, 2026
Merged
Conversation
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
![github-code-quality[bot]](https://avatars.githubusercontent.com/u/9919?s=60&v=4){kind=small}
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update existing documentation site to FumaDocs
Migrate documentation from VitePress to Fumadocs
Jan 19, 2026
Contributor
|
| @@ -0,0 +1,17 @@ | |||
| import type { DocsLayoutProps } from 'fumadocs-ui/layout'; | |||
| // @ts-ignore: optional dev dependency for icons (some environments may not have types) | |||
| import { Book, Code2, FileText, Sparkles } from 'lucide-react'; | |||
Contributor
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Replaces VitePress documentation site with Fumadocs-based Next.js application in
apps/sitedirectory with content at/content/docs.Changes
apps/siteas standalone Next.js 14 app with fumadocs-ui and fumadocs-mdxdocs/toapps/site/content/docs/, converted.md→.mdxformattitle) to all documentation files, quoted titles containing colons for YAML complianceapps/*to pnpm-workspace.yaml, new scripts:site:dev,site:build,site:start[[...slug]]patternDirectory Structure
Known Issues
Three files have MDX parsing errors due to inline TypeScript type annotations:
guide/configuration.mdx(line 45:(ObjectQLPlugin | string)[])guide/plugins.mdx(line 42: arrow comment syntax)spec/query-language.mdx(line 145:Record<string, {...}>)These need type annotations moved to code blocks or escaped. All other pages render correctly.
Screenshots
Landing page:
Documentation with sidebar and TOC:
Warning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
fonts.googleapis.com/usr/local/bin/node /usr/local/bin/node /home/REDACTED/work/objectql/objectql/apps/site/node_modules/next/dist/server/lib/start-server.js(dns block)If you need me to access, download, or install something from one of these locations, you can either:
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.